/*
 * Copyright 2013 Glassy Cinema.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package hu.glassy.web.page;

import java.io.Serializable;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.markup.html.panel.Panel;
import org.apache.wicket.model.IModel;
import org.apache.wicket.request.mapper.parameter.PageParameters;

/**
 * Weboldalak finkcióit összefogó interfész
 *
 * @author molnar.alexander@sonrisa.hu
 */
public interface BaseWebPage extends Serializable
{

  public static final String CONTENT_ID = "content";

  /**
   * A böngésző címsorában megjelenő cím
   */
  public IModel<String> getPageTitleModel();

  /**
   * Az oldal fejlécében megjeelnő panel
   *
   * @param panelId
   *                A visszaadott panel ID-ja
   */
  public Panel getHeaderPanel(String panelId);

  /**
   * Az oldal törzsében megjelenő panel
   *
   * @param panelId
   *                   A visszaadott panel ID-ja
   * @param parameters
   *                   HTTP kérés paraméterei
   */
  public Panel getContentPanel(String panelId, PageParameters parameters);

  /**
   * Beállítja a paraméterben kapott panelt az oldal paneljének
   *
   * @param panel
   * @param target
   */
  public void setContentPanel(Panel panel, AjaxRequestTarget target);

  /**
   * Vissza lép az előző panelre
   *
   * @param target
   */
  public void goBack(AjaxRequestTarget target);

  /**
   * Megvizsgálja, hogy vissza lehet-e menni az előző oldalra
   *
   * @return
   */
  public boolean isGoBackAllowed();
}
